home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / tri_bbs / trimem20.zip / README.1ST < prev    next >
Text File  |  1992-08-17  |  17KB  |  361 lines
  1.  
  2.                            TriMeM Membership Manager
  3.                                  (c) 1992
  4.                                 VERSION 2.0
  5.                                 written by
  6.                                Jeff Hutchens
  7.  
  8.  
  9. DISCLAIMER:
  10. I Jeff Hutchens will not be liable for any loss to you due to your use of this
  11. program.  Even if such loss results from the proper use of this program.  I
  12. will not be responsible for any damages or lost profits, or any other losses
  13. resulting from the use of or the inability to use this program.
  14.  
  15. SHAREWARE:
  16. This is being marketed under the Shareware concept.  As such, you may use this
  17. program free of charge for a period of 30 days.  After the 30 day evaluation
  18. period, you must register.  Registration is only $10.00 (US dollars).
  19. Use the attatched Register.txt registration form to register.
  20.  
  21. SUPPORT:
  22. Support may be obtained by logging onto the "lighthouse bbs" at 707-465-3974
  23. Or, by writing to me at the address on the register.txt document.
  24.  
  25. WHATS NEW WITH 2.0
  26. 2.0 Now allows "Registered" users to Create their own ansi and ascii
  27. notices for Ratios Upgrades/Downgrades.  Trimem 2.0 also contains 2 new
  28. Modules over version 1.0.  You can now Set Users security "Across the
  29. Board", meaning you can adjust all security level "10" to a new security.
  30. You can now "Reset" users file and message and number of calls to 0.
  31. Trimem 2.0 Also allows you to "Check for New Activity". This means that
  32. if you are running ratios and a user has not made any calls or downloaded
  33. any files, their security will not be changed until they do.
  34.  
  35. Also included with trimem 2.0 is a file called "Free.Exe"  More on this
  36. Later in the doc.
  37.  
  38. A VERY SPECIAL THANK you goes out to Lamar Smith of the Night Watch BBS.
  39. Lamar has put many hours into Alpha and Beta testing of the Trimem series.
  40. Without His help and suggestions, trimem would not have been possible.
  41. so THANK YOU LAMAR!!!!
  42.  
  43.  
  44. *******************************************************************************
  45.  
  46.                               WHAT IT IS
  47.                               ▀▀▀▀▀▀▀▀▀▀
  48.  
  49. TriMeM is a membership management utility.  It is run as a daily event, it
  50. keeps track of the number of days a member has remaining in his/her
  51. subscription when they reach a configured number of days left, TriMem will
  52. send them an appropriate user specific logon screen informing them that their
  53. subscription is about to run out.  When they reach a second configured number
  54. of days left, Trimem will send them a second and final notice that their
  55. subscription is about to run out.  When they reach 0 days left, TriMem lowers
  56. their security to a level you specify. Trimem Also contains internal Ratios
  57. Checking and security upgrade/downgrade, and internally generated logon
  58. screens for ratios violations or upgrades.
  59.  
  60.  
  61.                                 CONFIG FILE
  62.                                 ▀▀▀▀▀▀▀▀▀▀▀
  63.  
  64. You will need a file called: Members.Cfg. This file contains all the information
  65. TriMem needs to operate successfully.  The following is what each line of the
  66. config file requires for operation: The Bare Minimum for running any Trimem
  67. Feature, are lines 1 thru 3. Use only these 3 lines if you are going to use
  68. Trimem For the "Ratios" portion Only.
  69.  
  70. Line 1:     Path to your main bbs directory                   C:\Tribbs
  71. Line 2:     BBS Name                                          Lighthouse BBS
  72. Line 3:     Registration Number or 0 for none                 0
  73. Line 4:     Send First Notice at ?? Days                      30
  74. Line 5:     Send Final Notice at ?? Days                      3
  75. Line 6:     Low security to include as a member               LOWS=20
  76. Line 7:     High Security to include as a member              HIGH=60
  77. Line 8:     User possible Security level                      USER=20
  78. Line 9:     If users security is the above, givem ? days      DAYS=120
  79. Line 10:    Drop User to this level if time runs out          STOP=10
  80.  
  81. REPEAT LINES 8,9 AND 10 UNTIL ALL POSSIBLE SECURITY LEVELS ARE INCLUDED
  82. You must include the leading headers such as STOP= and LOWS=.
  83.  
  84. *****************************************************************************
  85.  
  86.                               PARAMATERS
  87.                               ▀▀▀▀▀▀▀▀▀▀
  88.  
  89. The Following Paramaters activate different portions of Trimem.
  90.  
  91. /?...................Gives you This File on screen and in color.
  92. /1...................Installs your Membership roster The First time.
  93. /2...................Checks for and Adds new members ONLY.
  94. /3...................Trimem Editor, lets you view members info.
  95. /4...................Verifys member numbers, if you have packed user base.
  96. /5...................Activates the Ratios Portion (see below).
  97. /6...................Change  ALL bbs users Security levels from one level to
  98.                      Another.
  99. /7...................Reset Users File/Message/Number of calls to 0 for
  100.                      All BBS users at one time.
  101.  
  102.  
  103. *****************************************************************************
  104.  
  105.                           MEMBERSHIP PORTION
  106.                           ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀
  107.  
  108. If you plan on using the Membership/Subscription portion of trimem, you'll
  109. need to make sure you have your config file prepared and in the same directory
  110. as Trimem.EXE.  After you have done this, Make sure that any users you want
  111. added as members, have the proper security levels in accordance with your
  112. config file. Then Run Trimem /1.  This will create your data file for you.
  113.  
  114. After your data file has been created, you may want to go in and have a look
  115. around and make sure your users have the correct amount of days in their
  116. subscription, and perhaps change some.  To do this, run Trimem /3.
  117.  
  118. If you have packed your user base on the bbs, You MUST run Trimem /4 before
  119. using any other of trimems features.  This updates the Member numbers in
  120. Trimem's Data file, so that when users are notified in the future of
  121. due subscriptions, a note will be sent to the proper user.  This switch "/4"
  122. is Trimems "Pack Member" option.
  123.  
  124. If you wish to simply add new members only, and not decrement any members
  125. number of days left, or send any notes, Run Trimem /2.  This will check for
  126. BBS users who have a "Membership" security level, but are not in the Member
  127. Roster.  Trimem will then add these new members to the roster.
  128.  
  129. ******************************************************************************
  130.  
  131.                                 RATIOS
  132.                                 ▀▀▀▀▀▀
  133.  
  134. Running Trimem with the " /5 " switch, will cause the ratios portion of
  135. Trimem to be activated.  You must have a file called "Ratios.Cfg" present
  136. in your trimem directory for this switch to be active.  the Format for this
  137. file is as follows:
  138.  
  139. Line 1:    The lowest security level to drop to, or include in the
  140. LOWS=      Ratio checking process.
  141.  
  142. Line 2:    The Highest Security level to raise users to. Users With This
  143. HIGH=      Security Level, Will Not be dropped in security due to Ratios
  144.            Violations, or raised any higher.
  145.  
  146. Line 3:    The type of ratio checking to be done.  To check ratios on files
  147. TYPE=      transfers only, put "Files" on this line.
  148.            To check for Message ratios only put "Messages" on this line.
  149.            To Check for both Message and File transfer ratios, put "Both" on
  150.            this line.
  151.  
  152. Line 4:    Up Message Ratio.  What you put on this line will be your message
  153. UPTO=      ratio factor for Increasing Security.  for instance a " 9 " here
  154.            would mean that for each  9 logons, a user must upload 1 message.
  155.            If he/she does, their security will be bumped UP.
  156.  
  157. Line 5:    Down Message Ratio.  What you put on this line will be your message
  158. DOWN=      ratio factor for Decreasing Security.  For instance a "20" here
  159.            would mean that for each 20 logons, a user must upload 1 message,
  160.            or else his/her security will be Bumped DOWN.
  161.  
  162. Line 6:    Up File Transfer Ratio. What you put on this line will be your File
  163. UPTO=      Transfer Ratio factor.  For instance a "10" here would mean that
  164.            if they stay under 10 downloads for each file uploaded, (or kbytes
  165.            downloaded if configured <below>) they will be Bumped UP in security.
  166.  
  167. Line 7:    Down File Transfer Ratio.  What you put on this line will be your
  168. DOWN=      File Transfer Ratio info for Downgrading security.  For Instance
  169.            a "20" here would mean that if they have downloaded more than
  170.            20 files (or kbytes if configured below) Their security will be
  171.            bumped DOWN.
  172.  
  173. Line 8:    The amount to decrement or increment user security by.  For
  174. RATE=      Instance a " 1 " here would mean that for every violation of
  175.            the setup above, 1 security point would be subtracted from the
  176.            users security.  For every " good " user who is in line with the
  177.            ratios, their security would be "increased" by this amount.
  178.  
  179. Line 9:    File type to use. a "FILES" on this line will use the number of
  180. KBYTES     uploads to the number of downloads as the ratio criteria. a
  181. FILES      "KBYTES" on this line will use the Kilobytes uploaded to the
  182. NONE       Kilobytes downloaded as the ratio criteria.
  183.            If you have toggled above to NOT use files or kbytes then put
  184.            "NOne" on this line;
  185.  
  186. Line 10:   Verify Toggle.  By Putting a "Verify" on this line, Trimem will
  187. VERIFY     Automatically check for new activity before raising or lowering
  188.            Any security levels.  If there has been no new activity, their
  189.            security will not change.  The Default is No Verify.  If you
  190.            do not wish to use the verify option, simply leave this line
  191.            blank or omit it.
  192.  
  193.  
  194. Here is a sample Ratios.cfg file. You must include the leading header words
  195. where they are:
  196.  
  197. lows=100
  198. high=200
  199. type=Both
  200. upto=10
  201. down=20
  202. upto=10
  203. down=20
  204. rate=5
  205. kbytes
  206. Verify
  207.  
  208.  
  209.  
  210. Trimem Will Accept a user with the Lows= level and raise them if its appropriate
  211. Trimem Will Not lower a user who has the High= security level. This is done
  212. so that trimem's ratios portion, and the Membership portion of the program
  213. will work hand in hand. A user can raise his/her security up to the maximum
  214. allowed by ratios, then the membership portion takes over and gives them
  215. "Un-ratio'd" subscription time.
  216.  
  217. ******************************************************************************
  218.  
  219.                              FREE FILES
  220.                              ▀▀▀▀▀▀▀▀▀▀
  221.  
  222. If you are running a support board, or have file areas on your board that
  223. you would like to be "Ratio Free" and you intend to use the ratios portion
  224. of Trimem, A Free files option has been made available. First, Make any
  225. File area that you wish to be a "Free" (no ratio) File Area Security of 0.
  226.  
  227. You MUST Run Free.Exe from your Between.Bat with the path to the Main BBS
  228. Directory as a paramater.  Example:   Free  C:\TriBBS
  229.  
  230. Free.Exe Will check your callers log for downloads and if any of the files
  231. Downloaded came from a file area with a security level of " 0 ", it will
  232. give them Credit in their  Users information.
  233.  
  234.  
  235. ******************************************************************************
  236.  
  237.                                  EXCLUSIONS
  238.                                  ▀▀▀▀▀▀▀▀▀▀
  239.                               (honorary members)
  240.  
  241.  
  242. You may optionally create a file called Exclude.Txt.  This file is an ascii
  243. text file and contains the names of users NOT to be included in the membership
  244. and Ratios, such as " honorary " members. Example:
  245.  
  246. Jeff Hutchens
  247. Joe Sysop
  248.  
  249. You may have as many exclusions as you like, up to about 800.
  250.  
  251. *****************************************************************************
  252.  
  253.                                  EVENTS
  254.                                  ▀▀▀▀▀▀
  255.  
  256. The Membership Portion of Trimem must be run Daily and without any paramaters.
  257. re: TRIMEM
  258.  
  259. The Ratios Portion of Trimem Should be a weekly event, Run with "/5".
  260. re: TRIMEM /5
  261.  
  262. The Free Files portion of Trimem Should be Run as a Caller by Caller in
  263. Your Between Bat.
  264. re: Free C:\TriBBS
  265.  
  266.  
  267.                                   Samples
  268.                                   ▀▀▀▀▀▀▀
  269.  
  270. Between.bat                     Daily Event                 Weekly Event
  271. -------------------------------------------------------------------------------
  272. cd c:\tribbs\trimem             cd c:\tribbs \trimem        cd c:\tribbs\trimem
  273. Free C:\TriBBS                  Trimem                      Trimem /5
  274. cd c:\tribbs                    cd c:\tribbs                cd c:\tribbs
  275.                                 board                       board
  276.  
  277. *******************************************************************************
  278.  
  279.                                 NOTES
  280.                                 ▀▀▀▀▀
  281.  
  282. Keep in mind that now that your set up, all you have to do to add new members
  283. is to simply give them the appropriate security level.  when your event runs
  284. later in the day, Trimem will pick up on the fact that this user is within the
  285. range of member security, but is not on the members list, and will add them.
  286. Make sure that you give them the proper security in accordance with the:
  287.  
  288. USER=seclevel
  289. DAYS=number of days to give them.
  290. STOP=drop them to this security level if their membership runs out
  291.  
  292. YOU MUST remember to include the proper stop= levels. For Example, say you
  293. have a user with a security of 90, you have trimem set to drop him/her to
  294. 80, but you have no "User=80" statement in your config file, then this
  295. user will not be returned to the member roster with a new subscription.
  296. If you DO have a "User=80" statement in your config file, This user will
  297. be added onto the End of the membership roster as a new member with the
  298. number of days configured for his new security level.
  299.  
  300.  
  301. After the event has run the first time, you can change their security from
  302. the BBS without affecting trimem.  Keep in mind that if they are still
  303. in the Membership Roster, and their time runs out. Their security will be
  304. dropped according to the info that went into the roster when they
  305. were first ADDED TO the Roster.  So if Changes are in order, you should
  306. use the " /3 " switch, and delete the user from the roster, then adjust their
  307. security on the bbs.  Trimem will then pick up on the new security level
  308. on the next event. and the process begins anew.
  309.  
  310. I Might add also that if you are running both Membership, and Ratios, they
  311. Can be configured so as to work hand in hand.  When a "Low Level" member
  312. is in violation of ratios, their membership level will change as well,
  313. Trimem's Ratio Module will delete them from the member roster and trimem
  314. will then "Re-Add" them as a new member with the new number of days for
  315. their new security level.
  316.  
  317.  
  318. *******************************************************************************
  319.  
  320.                          ASCII AND ANSI SCREENS
  321.                          ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀
  322.  
  323. The Registered version Will get rid of that nasty "UNREGISTERED" notice
  324. in the log on notes it creates. Trimem will not overwrite any log on screen.
  325. If you have user specific log on screens, trimem will simply append the
  326. existing file.  Trimem generates its own ascii and ansi files for this
  327. Purpose, No screens are required to be created. However, ONCE REGISTERED,
  328. You may optionally create your own screens for this purpose.  If you will
  329. be using custom screens, they must be present in the trimem directory.
  330. You May create any or all of these screens.  If trimem does not find a
  331. custom screen, it will simply use its own internal screens.
  332. You may stamp the date that the screen was sent to a user by inserting the
  333. symbol " # " in your screen. Two "#" together will stamp both the Date and
  334. Time The screen was sent: ##
  335.  
  336. The names of the eight screens you may Create Are:
  337.  
  338. Users.ANS      (first notice to send member <ansi type>)
  339. Warn.ANS       (final notice to send member (ansi type>)
  340. Users.BBS      (first notice to send member <ascii type>)
  341. Warn.BBS       (final notice to send member <ascii type>)
  342.  
  343. Ratiosup.ans   (if ratios have been adjusted UP send this ansi screen)
  344. Ratiosdn.ans   (if ratios have been adjusted Down, Send this ansi screen)
  345. Ratiosup.bbs   (if ratios have been adjusted UP send this ascii screen)
  346. Ratiosdn.bbs   (if ratios have been adjusted Down, Send this ascii screen)
  347.  
  348.  
  349. Many Long Hard hours and extensive long distance time has gone into the
  350. creation of Trimem. So Remember To Register Promptly!
  351.  
  352.  
  353.  
  354.  
  355.  
  356.  
  357.                                Thanks for using
  358.                                    TriMem
  359.                                      2.0
  360.  
  361.